CygNet COM API
The CygNet Software system includes an integrated set of COM automation libraries for programmatic access to CygNet services, clients, and other related entities. The purpose of the scripting reference library is to provide object and method specifications for public libraries available in a CygNet Software installation. Use these libraries to customize your system through CygNet Studio and Canvas screens, reports, and specialized HyperPoints.
Scripting Reference Libraries
CygNet Software supports a 32-bit version (found in the CygNet\Support directory) and a 64-bit version (found in the CygNet\Support64 directory) of each library. See the following topics for information about specific scripting libraries. See Installing 64-bit CygNet API Libraries for more information on installing the 64-bit libraries.
| 32-bit dll | 64-bit dll | Description | Link to API Help |
|---|---|---|---|
| CxAcs.dll | CxAcs64.dll | The library for Access Control Service (ACS) related objects. | CxAcs |
| CxAud.dll | CxAud64.dll | The library for Audit Service (AUD) related objects. | CxAud |
| CxCas.dll | CxCas64.dll | The library for Common Alarm Service (CAS) related objects. | CxCas |
| CxCvs.dll | CxCvs64.dll | The library for Current Value Service (CVS) related objects. | CxCvs |
| CxDds.dll | CxDds64.dll | The library for Device Definition Service (DDS) related objects. | CxDds |
| CxDialogs.dll | CxDialogs64.dll | The library for CygNet Dialog related objects. | CxDialogs |
| CxDynagraph.ocx | — | The library for human-interface objects related to the CygNet Dynagraph control. | CxDynagraph |
| CxEditors.dll | CxEditors64.dll | The library for service-editing objects. | CxEditors |
| CxEls.dll | CxEls64.dll | The library for Event Logging Service (ELS) related objects. | CxEls |
| CxEventIF.dll | CxEventIF64.dll | Describes the automation object which provides a way for scripts to set up and execute filtering queries. | CxEventIF |
| CxExport.dll | CxExport64.dll | The library for the ExportClient object, which allows users to export CygNet data in CSV format. | CxExport |
| CxFac.dll | CxFac64.dll | The library for Facility Service (FAC) related objects. | CxFac |
| CxFms.dll | CxFms64.dll | The library for CygNet Measurement (FMS) related objects. | CxFms |
| CxGns.dll | CxGns64.dll | The library for General Notification Service (GNS) related objects. | CxGns |
| CxGrp.dll | CxGrp64.dll | The library for Group Service (GRP) related objects. | CxGrp |
| CxHmiCas.ocx | — | The library for human-interface objects related to the Common Alarm Service (CAS) and CASView control. | CxHmiCas |
| CxHmiFac.ocx | — | The library for human-interface objects related to the Facility Service (FAC), specifically the FacNavBar control. | CxHmiFac |
| CxHmiFms.ocx | — | The library for human-interface objects related to the CygNet Measurement Service (FMS) controls. | CxHmiFms |
| CxHmiGcm.ocx | — | The library for human-interface objects related to the CygNet General Contract Monitoring (GCM) feature. | CxHmiGcm |
| CxHmiGrp.ocx | CxHmiGrp64.ocx | The library for human-interface objects related to the Group Service (GRP) related object controls (Group Grid, Group NavBar, Group Tree). | CxHmiGrp |
| CxHmiRsm.ocx | — | The library for Remote Service Management (RSM) related objects. | CxHmiRsm |
| CxNote.dll | CxNote64.dll | The library for Note Service (NOTE) related objects. | CxNote |
| CxPnt.dll | CxPnt64.dll | The library for Point Service (PNT) related objects. | CxPnt |
| CxScript.dll | CxScrtipt64.dll | This library provides the backbone for CygNet global scripting. | CxScript |
| CxTrend.ocx | CxTrend64.ocx | The library for human-interface objects related to the many trending options found in CygNet Software. | CxTrend |
| CxUis.dll | CxUis64.dll | The library for Universal Interface Service (UIS) related objects. | CxUis |
| CxVhs.dll | CxVhs64.dll | The library for Value History Service (VHS) related objects. | CxVhs |
Scripting Conventions
All methods are documented for use with VBScript. Data types are given for each parameter, although VBScript supports only the variant type; all other types are sub-types of the variant.
Note: VBScript is deprecated effective October 2023. In future releases of Windows, VBScript will be available as a feature on demand before its removal from the operating system. See Resources for deprecated features for more information.
Scripting Examples
Examples provided with each method are intended to show the basic usage of the method. Examples that are particular to an environment (HSS or CygNet Studio) are indicated by a bracketed environment name preceding the script. Many examples may be copied directly into a scripting environment and run as is, although the literal names of services, devices, etc. will need to be changed.
Note: Error handling in the provided examples is minimal to maintain clarity, and should be added as necessary in a working script.
